Skip to content

reference-designs/eval-ad7134-fmcz: Add eval-ad7134-fmcz documentation#400

Open
mandrica wants to merge 2 commits intomainfrom
ad7134_doc
Open

reference-designs/eval-ad7134-fmcz: Add eval-ad7134-fmcz documentation#400
mandrica wants to merge 2 commits intomainfrom
ad7134_doc

Conversation

@mandrica
Copy link
Copy Markdown
Collaborator

Type

  • Documentation
  • Bug fix
  • New feature
  • Continuous integration

Checklist

Signed-off-by: mandrica <maria-zoita.andrica@analog.com>
@mandrica mandrica requested review from StancaPop and sarpadi March 31, 2026 15:50
@mandrica mandrica added the human This content was made by a human label Mar 31, 2026
Comment on lines +30 to +31
Features
~~~~~~~~
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Features
~~~~~~~~
Features:

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


EVAL-AD7134-FMCZ
=================

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Copy Markdown
Collaborator

@StancaPop StancaPop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Needs technical review.

Signed-off-by: mandrica <maria-zoita.andrica@analog.com>
@gastmaier gastmaier added the llm review Request a review from a LLM Reviewer label Apr 23, 2026
@github-actions
Copy link
Copy Markdown
Contributor

LLM review

This series adds the EVAL-AD7134-FMCZ reference design documentation (5 .rst files, 32 images).

run: 24826868245

c813935 - eval-ad7134-fmcz: Add and update doc files/images

Missing imported from: marker: ad7134_iio_support.rst is a direct import from wiki.analog.com but is missing the required header line:

.. imported from: https://wiki.analog.com/resources/tools-software/product-support-software/ad7134_iio_support

Wrong product URL for AD4134: The :adi: role for AD4134 incorrectly points to the AD7134 page:

:adi:`AD4134 <en/products/ad7134.html>`  # wrong
:adi:`AD4134 <en/products/ad4134.html>`  # correct

Wiki links should use intersphinx: Three references in ad7134_iio_support.rst point to wiki.analog.com pages that have been imported into the precision-converters-firmware documentation:

# pcg-fw-mbed-build-guide → :external+precision-converters-firmware:doc:`source/build/project_build`
# pcg-fw-stm32-build-guide → :external+precision-converters-firmware:doc:`source/build/project_build_stm32`
# data-capture-using-iio-app → :external+precision-converters-firmware:doc:`source/iio_osc/data_capture_and_dmm`

Raw GitHub release links: The download admonitions for libiio and IIO Oscilloscope use plain GitHub URLs. Use git roles instead:

:git-libiio:`releases+`
:git-iio-oscilloscope:`releases+`

Duplicate HDL entry in index.rst: Both :external+hdl:ref: and :git-hdl: link to the same HDL project. Keep only the :external+hdl:ref: entry.

Custom titles on Sphinx refs (all files): Per guidelines, :external+hdl:ref: should not use custom titles when the label's own title suffices:

:external+hdl:ref:`HDL reference design <ad7134_fmc>`  # drop custom title
:external+hdl:ref:`SPI Engine Framework <spi_engine>`  # drop custom title (appears in index.rst and user-guide.rst)

Global improvement

docs/solutions/reference-designs/ad7768-1-evb/quickstart/ad77681_mbed_iio_app.rst:185 also contains a :dokuwiki: link to data-capture-using-iio-app that should use the same intersphinx reference.

Suggested patches

Apply the suggested patches with:

cd path/to/repository
export GITHUB_TOKEN=ghp_***
apply-patches --repo=analogdevicesinc/documentation 24826868245
Install instructions

The following one-liner installs the script if not present already:

grep "/apply-patches.sh" ~/.bashrc ||  { curl "https://raw.githubusercontent.com/analogdevicesinc/doctools/refs/heads/main/ci/scripts/apply-patches.sh"    -o ~/.local/bin/apply-patches.sh &&  echo "source ~/.local/bin/apply-patches.sh" >> ~/.bashrc ; source ~/.bashrc ; }

More information at AI Usage.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

human This content was made by a human llm review Request a review from a LLM Reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants